Endpoint Profile by ID
Route
/v2/endpoint-management/profiles/{id}
Description
Retrieve a profile, update its metadata or targeting, or delete it when it is no longer applied.
Methods
- GET — fetch a profile by ID
- PATCH — update profile fields
- DELETE — delete a profile
Inputs
| Parameter | Type | Required | Description |
|---|---|---|---|
id | string | Yes | Profile ID in the path |
profile | UpdateProfile | Yes (PATCH) | Fields to update (name, description, status, priority, applied_configurations, uninstall_enabled, targeting, override_configuration) |
fields | string | No (PATCH) | Comma-separated list of fields to update |
Request Example (PATCH)
{
"description": "Updated messaging for the secure Mac fleet profile.",
"priority": 150,
"targeting": {
"type": "cel",
"query": "device.os == \"macos\" && device.is_corporate"
}
}
Output (GET/PATCH)
| Field | Type | Description |
|---|---|---|
type | string | Always "profiles" |
size | integer | Number of profiles returned |
resources | array[Profile] | Profile object |
errors | array[Error] | Any errors |
Profile Object (key fields)
| Field | Type | Description |
|---|---|---|
id | string | Profile identifier |
name | string | Profile name |
description | string | Description |
type | string | Profile type |
status | string | Profile status |
applied_configurations | AppliedProfileConfigurations | Attached configuration modules |
uninstall_enabled | boolean | Remote uninstall allowed |
priority | integer | Priority for targeting |
targeting | Targeting | Targeting rules |
override_configuration | object | Additional JSON overrides |
Rate Limit
- 60 requests per minute per API key
- 5 concurrent requests per endpoint
Example Response (GET)
{
"type": "profiles",
"size": 1,
"resources": [
{
"id": "profile-secure-laptops",
"name": "Secure Laptops",
"description": "Updated messaging for the secure Mac fleet profile.",
"type": "endpoint_sensor",
"status": "active",
"applied_configurations": {
"performance_configuration": "config-performance",
"detection_configuration": "config-detection"
},
"uninstall_enabled": false,
"priority": 150,
"targeting": {
"type": "cel",
"query": "device.os == \"macos\" && device.is_corporate"
}
}
],
"errors": []
}